/*
 * Copyright (c) 2002-2021 "Neo4j,"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.neo4j.ogm.result.adapter;

import java.util.regex.Pattern;

/**
 * This adapter interface should be implemented by all drivers
 *
 * @author Vince Bickers
 * @author Michael J. Simons
 */
public interface ResultAdapter<F, T> {

    Pattern PATTERN_COMPREHENSION_PATTERN = Pattern.compile("^\\[.+|.+\\]$");

    /**
     * Helper method that checks whether the given result key ("column name") describes a node generated by
     * pattern comprehension.
     *
     * @param resultKey
     * @return True, if the result key describes a node generated by pattern comprehension
     */
    static boolean describesGeneratedNode(String resultKey) {
        return PATTERN_COMPREHENSION_PATTERN.matcher(resultKey).matches();
    }

    T adapt(F result);
}
